package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.UserReadCompanySysNoticeAddDTO;
import org.jsola.hr.dto.UserReadCompanySysNoticeUpdateDTO;
import org.jsola.hr.query.UserReadCompanySysNoticeQuery;
import org.jsola.hr.vo.UserReadCompanySysNoticeListVO;
import org.jsola.hr.vo.UserReadCompanySysNoticeVO;

import java.util.List;

/**
 * 用户已阅公司系统公告(用户阅读公司系统公告后添加)
 *
 * @author zhr
 */
@Api(tags = "hr-用户已阅公司系统公告(用户阅读公司系统公告后添加)")
public interface IUserReadCompanySysNoticeControllerAPI {

    /**
     * 新增用户已阅公司系统公告(用户阅读公司系统公告后添加)
     * @param userReadCompanySysNoticeAddDTO 用户已阅公司系统公告(用户阅读公司系统公告后添加)新增实体
     * @return 用户已阅公司系统公告(用户阅读公司系统公告后添加)展示对象
     */
    @ApiOperation(value = "新增用户已阅公司系统公告(用户阅读公司系统公告后添加)")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "userReadCompanySysNoticeAddDTO", dataType = "UserReadCompanySysNoticeAddDTO", value = "新增用户已阅公司系统公告(用户阅读公司系统公告后添加)", paramType = "body")
    })
    Result<UserReadCompanySysNoticeVO> save(UserReadCompanySysNoticeAddDTO userReadCompanySysNoticeAddDTO);


    /**
     * 修改用户已阅公司系统公告(用户阅读公司系统公告后添加)
     * @param userReadCompanySysNoticeUpdateDTO 用户已阅公司系统公告(用户阅读公司系统公告后添加)
     * @return 更新数量
     */
    @ApiOperation(value = "修改用户已阅公司系统公告(用户阅读公司系统公告后添加)")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "userReadCompanySysNoticeUpdateDTO", dataType = "UserReadCompanySysNoticeUpdateDTO", value = "修改用户已阅公司系统公告(用户阅读公司系统公告后添加)", paramType = "body")
    })
    Result<Integer> update(UserReadCompanySysNoticeUpdateDTO userReadCompanySysNoticeUpdateDTO);




    /**
     * 删除单个用户已阅公司系统公告(用户阅读公司系统公告后添加)，彻底删除
     * @param userReadCompanySysNoticeId 用户已阅公司系统公告(用户阅读公司系统公告后添加)id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个用户已阅公司系统公告(用户阅读公司系统公告后添加)，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "userReadCompanySysNoticeId", dataType = "String", value = "用户已阅公司系统公告(用户阅读公司系统公告后添加)id", paramType = "path")
    })
    Result<Integer> delete(String userReadCompanySysNoticeId);


    /**
     * 批量删除用户已阅公司系统公告(用户阅读公司系统公告后添加)，彻底删除
     * @param userReadCompanySysNoticeIds 用户已阅公司系统公告(用户阅读公司系统公告后添加)id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除用户已阅公司系统公告(用户阅读公司系统公告后添加)，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "userReadCompanySysNoticeIds", dataType = "String[]", value = "用户已阅公司系统公告(用户阅读公司系统公告后添加)id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] userReadCompanySysNoticeIds);


    /**
     * 根据用户已阅公司系统公告(用户阅读公司系统公告后添加)id查询用户已阅公司系统公告(用户阅读公司系统公告后添加)详情
     * @param userReadCompanySysNoticeId 用户已阅公司系统公告(用户阅读公司系统公告后添加)id
     * @return 用户已阅公司系统公告(用户阅读公司系统公告后添加)详情
     */
    @ApiOperation(value="根据用户已阅公司系统公告(用户阅读公司系统公告后添加)id查询用户已阅公司系统公告(用户阅读公司系统公告后添加)详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "userReadCompanySysNoticeId", dataType = "String", value = "用户已阅公司系统公告(用户阅读公司系统公告后添加)id", paramType = "path")
    })
    Result<UserReadCompanySysNoticeVO> findById(String userReadCompanySysNoticeId);


    /**
     * 查询用户已阅公司系统公告(用户阅读公司系统公告后添加)
     * @param userReadCompanySysNoticeQuery 用户已阅公司系统公告(用户阅读公司系统公告后添加)查询参数
     * @return page
     */
    @ApiOperation(value="查询用户已阅公司系统公告(用户阅读公司系统公告后添加)")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "userReadCompanySysNoticeQuery", dataType = "UserReadCompanySysNoticeQuery", value = "用户已阅公司系统公告(用户阅读公司系统公告后添加)查询参数", paramType = "query")
    })
    Result<List<UserReadCompanySysNoticeListVO>> listAll(UserReadCompanySysNoticeQuery userReadCompanySysNoticeQuery);


     /**
     * 分页查询用户已阅公司系统公告(用户阅读公司系统公告后添加)
     * @param userReadCompanySysNoticeQuery 用户已阅公司系统公告(用户阅读公司系统公告后添加)查询参数
     * @return page
     */
    @ApiOperation(value="分页查询用户已阅公司系统公告(用户阅读公司系统公告后添加)")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "userReadCompanySysNoticeQuery", dataType = "UserReadCompanySysNoticeQuery", value = "用户已阅公司系统公告(用户阅读公司系统公告后添加)查询参数", paramType = "query")
    })
    Result<Page<UserReadCompanySysNoticeListVO>> page(UserReadCompanySysNoticeQuery userReadCompanySysNoticeQuery);


}

